Modified README.rst Code Examples #797
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some examples provided in the README.rst file were no longer functional. I swapped those examples out with functional features and added expected outputs to all examples in README.rst file. Signed-Off-By: Jody Hunter <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some README.rst code examples were either no longer functional or produced no output.
I swapped those examples out with functional features or modified them to produce output and
added expected outputs to all examples in README.rst file. This should improve new user experience
in learning how to utilize the software and what to expect from examples being followed.
Changed the 'Get instances of all NHL teams for the 2018 season' to 'Get stats of a specified NHL player'.
Changed the 'Get a specific NFL team's season information' to 'Get a specific NFL team's wins and losses for the season'.
Changed the 'Get a Pandas DataFrame of all stats for an MLB game' to 'Get the batting average and home run total for each MLB team' due to Pandas functionality producing errors.
'closes #793'